<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Emitters that Support Report Rendering</title>
<style type="text/css">@import url("file:/C:/JAHT/eclipse/plugins/org.eclipse.platform_3.3.200.v200908070800/book.css");</style>
<style type="text/css">@import url("file:/C:/JAHT/eclipse/configuration/org.eclipse.osgi/bundles/170/1/.cp/schema.css");</style>
</HEAD>
<BODY>
<H1 style="text-align:center">Emitters that Support Report Rendering</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.birt.report.engine.emitters<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>2.2.0
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>This extension point allows new output formats to be supported in presentation engine.  The plugin registry uses this extension point registration to discover all supported output formats.<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.emitter">emitter</a>+)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
root element for the emitters extension</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>point</b> - a fully qualified identifier of the target extension point</li>
<li><b>id</b> - an optional identifier of the extension instance</li>
<li><b>name</b> - an optional name of the extension instance</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.emitter">emitter</a> (<a href="#e.reportItem">reportItem</a>*)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST emitter</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">format&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">icon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">mimeType&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">supportedImageFormats&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">pagination&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(no-pagination|page-break-pagination|paper-size-pagination) </p><p class="code SchemaDtdAttlist">outputDisplayNone&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(true | false) </p><p class="code SchemaDtdAttlist">isHidden&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(true | false) </p><p class="code SchemaDtdAttlist">needOutputResultSet&nbsp;&nbsp;&nbsp;(true | false) </p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
an emitter that exports one or more output formats</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - an optional identifier of the emitter extension</li>
<li><b>class</b> - the java class that implements the <code>IContentEmitter</code> interface</li>
<li><b>format</b> - The output format that the emitter supports</li>
<li><b>icon</b> - The icon path of the emitter</li>
<li><b>mimeType</b> - The MIME type for the supported output format</li>
<li><b>supportedImageFormats</b> - The supported image formats</li>
<li><b>pagination</b> - Pagination of output.
<br>When "page-break-pagination" is set, pagination is based on page break configuration.It is the default value of pagination.
<br>When "no-pagination" is set, content in the report is output as they are in one page.
<br>When "paper-size-pagination" is set, pagination is created based on contents size.</li>
<li><b>outputDisplayNone</b> - </li>
<li><b>isHidden</b> - Used to determine whether format is shown in UI</li>
<li><b>needOutputResultSet</b> - Represents if the emitter needs to output query result set.</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.reportItem">reportItem</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST reportItem</p>
<p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">class&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
allows a developer to define emitter for a report item. Used mainly for extended item, but can also be used for standard report items.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>name</b> - the name of the report item that the emitterClass supports. For example, "chart" for chart extension item</li>
<li><b>class</b> - the emitter class that supports this type of report item for a specific format</li>
<li><b>id</b> - an optional identifier of the report item emitter extension</li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>The following is a sample usage of the emitterSet extension point:

<p>
<pre class="Example"><span class="code SchemaTag">

&lt;extension 
 point=</span><span class="code SchemaCstring">&quot;org.eclipse.birt.report.engine.emitterSet&quot;</span><span class="code SchemaTag">
 name = </span><span class="code SchemaCstring">&quot;Engine Emitters&quot;</span><span class="code SchemaTag">&gt;
 &lt;emitter 
  format=</span><span class="code SchemaCstring">&quot;HTML&quot;</span><span class="code SchemaTag"> 
  id=</span><span class="code SchemaCstring">&quot;org.eclipse.birt.report.engine.emitter.html&quot;</span><span class="code SchemaTag">
  class=</span><span class="code SchemaCstring">&quot;org.eclipse.birt.report.engine.emitter.html.HTMLReportEmitter&quot;</span><span class="code SchemaTag">&gt;
  &lt;reportItem name=</span><span class="code SchemaCstring">&quot;chart&quot;</span><span class="code SchemaTag">
   id=</span><span class="code SchemaCstring">&quot;org.eclipse.birt.report.engine.emitter.chart.html&quot;</span><span class="code SchemaTag">
   class=</span><span class="code SchemaCstring">&quot;org.eclipse.birt.report.engine.emitter.html.HTMLChartEmitter&quot;</span><span class="code SchemaTag">&gt;
  &lt;/reportItem&gt;
 &lt;/emitter&gt;
 &lt;emitter 
  format=</span><span class="code SchemaCstring">&quot;FO&quot;</span><span class="code SchemaTag"> 
  mimeType=</span><span class="code SchemaCstring">&quot;text/html&quot;</span><span class="code SchemaTag">
  pagination=</span><span class="code SchemaCstring">&quot;no-page&quot;</span><span class="code SchemaTag">
  id=</span><span class="code SchemaCstring">&quot;org.eclipse.birt.report.engine.emitter.fo&quot;</span><span class="code SchemaTag">
  class=</span><span class="code SchemaCstring">&quot;org.eclipse.birt.report.engine.emitter.html.FOReportEmitter&quot;</span><span class="code SchemaTag">&gt;
  &lt;reportItem name=</span><span class="code SchemaCstring">&quot;chart&quot;</span><span class="code SchemaTag">
     id=</span><span class="code SchemaCstring">&quot;org.eclipse.birt.report.engine.emitter.chart.fo&quot;</span><span class="code SchemaTag">
   Class=</span><span class="code SchemaCstring">&quot;org.eclipse.birt.report.engine.emitter.html.FOChartEmitter&quot;</span><span class="code SchemaTag">/&gt;
 &lt;/emitter&gt;
 &lt;emitter
  mimeType=</span><span class="code SchemaCstring">&quot;application/pdf&quot;</span><span class="code SchemaTag">
  id=</span><span class="code SchemaCstring">&quot;org.eclipse.birt.report.engine.emitter.pdf&quot;</span><span class="code SchemaTag">
  class=</span><span class="code SchemaCstring">&quot;org.eclipse.birt.report.engine.emitter.html.FOPReportEmitter&quot;</span><span class="code SchemaTag">&gt; 
  &lt;reportItem name=</span><span class="code SchemaCstring">&quot;chart&quot;</span><span class="code SchemaTag">
   id=</span><span class="code SchemaCstring">&quot;org.eclipse.birt.report.engine.emitter.chart.pdf&quot;</span><span class="code SchemaTag">
   emitterClass=</span><span class="code SchemaCstring">&quot;org.eclipse.birt.report.engine.emitter.html.FOChartEmitter&quot;</span><span class="code SchemaTag">/&gt;
  &lt;/emitter&gt;
&lt;/extension&gt;
</span></pre>
<p>

Notice that in this example, the same class is used for both PDF and FO format. BIRT currently uses FO to generate both FO and PDF output.
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>The value of the class attribute for the emitter element must be the fully qualified name of a class that implement  <code>org.eclipse.birt.engine.emitter.IContentEmitter</code>.<p>
The value of the emitterClass attribute for the reportItem element must be a fully  qualified name of a class that implements <code>org.eclipse.birt.engine.extension.IReportItemEmitter</code>.
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6><code>org.eclipse.birt.report.engine.emitter.html.HTMLReportEmitter</code> ---- An HTML emitter that supports report rendering to HTML format.
<code>org.eclipse.birt.report.engine.layout.impl.ReportLayoutEngine</code> ---- An emitter that supports report rendering to PDF format.
<p></p>

<br>
<p class="note SchemaCopyright">
Copyright (c) 2005 Actuate Corporation. All rights reserved. This program and 
the accompanying materials are made available under the terms of the Eclipse 
Public License v2.0 which accompanies this distribution, and is available at 
http://www.eclipse.org/legal/epl-2.0.html<br><br>

Contributors: Actuate Corporation - initial API and implementation

</p>
</BODY>
</HTML>
